Skip to content

docs: migrate CLAUDE.md to AGENTS.md #788 - #789

Merged
mart-sessman merged 1 commit into
rcfrom
docs/788-agents-md
Oct 19, 2026
Merged

docs: migrate CLAUDE.md to AGENTS.md #788#789
mart-sessman merged 1 commit into
rcfrom
docs/788-agents-md

Conversation

@mart-sessman

@mart-sessman mart-sessman commented Oct 16, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Closes #788

  • AGENTS.md: the former CLAUDE.md content with a tool-neutral intro, so Codex, Copilot, Cursor and CodeRabbit read the same instructions as Claude Code.
  • CLAUDE.md: now a one-line @AGENTS.md import. Keeps the instructions loading on Claude Code < 2.1.277 and for contributors with a CLAUDE.local.md (which otherwise makes Claude skip AGENTS.md). The import never loads the file twice.
  • .coderabbit.yaml and the contributing skill now point to AGENTS.md.

Summary by CodeRabbit

  • Documentation
    • Added repository guidance for coding agents, including project conventions, testing practices, and review guidance.
    • Updated contributor and project review instructions to refer to the repository guidance.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •
edited
Loading

Copy link
Copy Markdown

Review in Change Stack →

Warning

This pull request changes a CodeRabbit configuration file. Because it comes from a fork or its author is not a repository collaborator, reviews use only the configuration from the target branch. The proposed configuration will take effect after it is merged.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: TEDI-Design-System/angular/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 232f8abb-afc4-49da-84b4-5c2a463f6529
📥 Commits

Reviewing files that changed from the base of the PR and between ecaa297 and 9701130.

📒 Files selected for processing: 4
  • .claude/skills/contributing/SKILL.md
  • .coderabbit.yaml
  • AGENTS.md
  • CLAUDE.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The pull request adds repository guidance to AGENTS.md. It updates CLAUDE.md, .coderabbit.yaml, and the contributing skill to reference AGENTS.md.

Changes: Repository guidance migration

Layer / File(s) Summary
Add repository guidance
AGENTS.md		 Adds guidance for repository structure, development conventions, testing, Storybook, commits, and review practices.
Update guidance references
CLAUDE.md, .coderabbit.yaml, .claude/skills/contributing/SKILL.md		 Replaces the guidance in CLAUDE.md with a reference to AGENTS.md. Updates the project-conventions references in the CodeRabbit configuration and contributing skill.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 97011

No concrete merge-blocking issue was established in this documentation-only migration.

### Architecture Summary

Architecture risk: 🔵 Low · up to 97011

The change affects 2 systems.

Changed systems: AGENTS.md, CLAUDE.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — AGENTS.md (service) was modified; 1 changed file maps to changed impact.
  • observed — CLAUDE.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in AGENTS.md: Introduces the repository overview, npm commands, directory layout, and package/workspace locations.
  • observed — Modified behavior in AGENTS.md: Documents component file conventions, Angular component patterns, the export chain, and path aliases.
  • observed — Modified behavior in AGENTS.md: Adds styling, testing, and Storybook conventions, including selector and naming rules, coverage thresholds, and story metadata.
  • observed — Modified behavior in AGENTS.md: Adds commit requirements, related-repository references and CI availability limits, and branch descriptions.
Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies the main change: migrating repository guidance from CLAUDE.md to AGENTS.md.
Linked Issues check Passed Issue #788 has coding and documentation requirements. The reviewed PR adds AGENTS.md with the repository guidance, replaces CLAUDE.md with the one-line @AGENTS.md import, and updates `.coderabbi…
Out of Scope Changes check Passed The reported changes are limited to AGENTS.md, CLAUDE.md, .coderabbit.yaml, and .claude/skills/contributing/SKILL.md. Each change supports issue #788 by migrating shared instructions, preservi…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue #788 has coding and documentation requirements. The reviewed PR adds AGENTS.md with the repository guidance, replaces CLAUDE.md with the one-line @AGENTS.md import, and updates .coderabbit.yaml and .claude/skills/contributing/SKILL.md to reference AGENTS.md. The supplied change summary reports the former 160-line guidance moved to AGENTS.md. The new introduction is tool-neutral, and the remaining CodeRabbit review guidance is applicable to its stated purpose. No automated test is required for these documentation-only changes.

Full details: Out of Scope Changes check

Explanation

The reported changes are limited to AGENTS.md, CLAUDE.md, .coderabbit.yaml, and .claude/skills/contributing/SKILL.md. Each change supports issue #788 by migrating shared instructions, preserving the Claude import, or updating instruction references. The evidence shows no unrelated product or dependency changes.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions

github-actions Bot commented Oct 16, 2026

Copy link
Copy Markdown

♿ Accessibility — ✅ no blocking violations

No accessibility violations in the components changed by this PR.

🔕 Known issues — 19 stories marked todo (warn only)

Stories

@mart-sessman mart-sessman mentioned this pull request Oct 16, 2026
Merged
@mart-sessman
mart-sessman merged commit e4f6215 into rc Oct 19, 2026
36 checks passed
@mart-sessman
mart-sessman deleted the docs/788-agents-md branch October 19, 2026 13:11

This branch was successfully deployed

1 active deployment
github-pages — 97011300 Deployed Oct 16, 2026 by mart-sessman via Deploy #1260
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ly-tempel-bitweb ly-tempel-bitweb Awaiting requested review from ly-tempel-bitweb
@intermetric intermetric Awaiting requested review from intermetric

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md and migrate CLAUDE.md to it

1 participant

@mart-sessman